/*
 Licensed to Diennea S.r.l. under one
 or more contributor license agreements. See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership. Diennea S.r.l. licenses this file
 to you under the Apache License, Version 2.0 (the
 "License"); you may not use this file except in compliance
 with the License.  You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing,
 software distributed under the License is distributed on an
 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.

 */

package herddb.index.blink;

import java.io.IOException;
import java.util.Map;

/**
 * @author diego.salvi
 */
public interface BLinkIndexDataStorage<X, Y> {

    long NEW_PAGE = -1;

    /**
     * Load an internal node data page.
     */
    void loadNodePage(long pageId, Map<X, Long> data) throws IOException;

    /**
     * Load a leaf node data page.
     */
    void loadLeafPage(long pageId, Map<X, Y> data) throws IOException;

    /**
     * Create a new internal node page for given data.
     */
    long createNodePage(Map<X, Long> data) throws IOException;

    /**
     * Create a new leaf node page for given data.
     */
    long createLeafPage(Map<X, Y> data) throws IOException;

    /**
     * Overwrite an existing internal node page with given data.
     */
    void overwriteNodePage(long pageId, Map<X, Long> data) throws IOException;

    /**
     * Overwrite an existing leaf node page with given data.
     */
    void overwriteLeafPage(long pageId, Map<X, Y> data) throws IOException;

}
